<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>phpDocumentor » \ActiveRecord\Column</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">phpDocumentor</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/ActiveRecord.html"><i class="icon-folder-open"></i> ActiveRecord</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">310</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">5</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">3</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method_cast" title="cast :: Casts a value to the column's type."><span class="description">Casts a value to the column's type.</span><pre>cast()</pre></a></li>
<li class="method public "><a href="#method_map_raw_type" title="map_raw_type :: Sets the $type member variable."><span class="description">Sets the $type member variable.</span><pre>map_raw_type()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties
                    <ul>
<li class="property public "><a href="#property_TYPE_MAPPING" title="$TYPE_MAPPING :: Map a type to an column type."><span class="description"></span><pre>$TYPE_MAPPING</pre></a></li>
<li class="property public "><a href="#property_auto_increment" title="$auto_increment :: True if this column is set to auto_increment."><span class="description"></span><pre>$auto_increment</pre></a></li>
<li class="property public "><a href="#property_default" title="$default :: The default value of the column."><span class="description"></span><pre>$default</pre></a></li>
<li class="property public "><a href="#property_inflected_name" title="$inflected_name :: The inflected name of this columns ."><span class="description"></span><pre>$inflected_name</pre></a></li>
<li class="property public "><a href="#property_length" title="$length :: The maximum length of this column."><span class="description"></span><pre>$length</pre></a></li>
<li class="property public "><a href="#property_name" title="$name :: The true name of this column."><span class="description"></span><pre>$name</pre></a></li>
<li class="property public "><a href="#property_nullable" title="$nullable :: True if this column allows null."><span class="description"></span><pre>$nullable</pre></a></li>
<li class="property public "><a href="#property_pk" title="$pk :: True if this column is a primary key."><span class="description"></span><pre>$pk</pre></a></li>
<li class="property public "><a href="#property_raw_type" title="$raw_type :: The raw database specific type."><span class="description"></span><pre>$raw_type</pre></a></li>
<li class="property public "><a href="#property_sequence" title="$sequence :: Name of the sequence to use for this column if any."><span class="description"></span><pre>$sequence</pre></a></li>
<li class="property public "><a href="#property_type" title="$type :: The type of this column: STRING, INTEGER, ."><span class="description"></span><pre>$type</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants
                    <ul>
<li class="constant  "><a href="#constant_DATE" title="DATE :: "><span class="description">DATE</span><pre>DATE</pre></a></li>
<li class="constant  "><a href="#constant_DATETIME" title="DATETIME :: "><span class="description">DATETIME</span><pre>DATETIME</pre></a></li>
<li class="constant  "><a href="#constant_DECIMAL" title="DECIMAL :: "><span class="description">DECIMAL</span><pre>DECIMAL</pre></a></li>
<li class="constant  "><a href="#constant_INTEGER" title="INTEGER :: "><span class="description">INTEGER</span><pre>INTEGER</pre></a></li>
<li class="constant  "><a href="#constant_STRING" title="STRING :: "><span class="description">STRING</span><pre>STRING</pre></a></li>
<li class="constant  "><a href="#constant_TIME" title="TIME :: "><span class="description">TIME</span><pre>TIME</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\ActiveRecord\Column"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/ActiveRecord.html">ActiveRecord</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/ActiveRecord.Column.html">Column</a>
</li>
</ul>
<div class="element class">
<p class="short_description">Class for a table column.</p>
<div class="details">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/ActiveRecord.html">ActiveRecord</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a id="method_cast"></a><div class="element clickable method public method_cast" data-toggle="collapse" data-target=".method_cast .collapse">
<h2>Casts a value to the column's type.</h2>
<pre>cast(mixed $value, <a href="../classes/ActiveRecord.Connection.html">\ActiveRecord\Connection</a> $connection) : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$value</h4>
<code>mixed</code><p>The value to cast</p></div>
<div class="subelement argument">
<h4>$connection</h4>
<code><a href="../classes/ActiveRecord.Connection.html">\ActiveRecord\Connection</a></code><p>The Connection this column belongs to</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>type-casted value</div>
</div></div>
</div>
<a id="method_map_raw_type"></a><div class="element clickable method public method_map_raw_type" data-toggle="collapse" data-target=".method_map_raw_type .collapse">
<h2>Sets the $type member variable.</h2>
<pre>map_raw_type() : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Returns</h3>
<div class="subelement response"><code>mixed</code></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_TYPE_MAPPING"> </a><div class="element clickable property public property_TYPE_MAPPING" data-toggle="collapse" data-target=".property_TYPE_MAPPING .collapse">
<h2></h2>
<pre>$TYPE_MAPPING : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<table class="table table-bordered"><tr>
<th>static</th>
<td></td>
</tr></table>
</div></div>
</div>
<a id="property_auto_increment"> </a><div class="element clickable property public property_auto_increment" data-toggle="collapse" data-target=".property_auto_increment .collapse">
<h2></h2>
<pre>$auto_increment : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_default"> </a><div class="element clickable property public property_default" data-toggle="collapse" data-target=".property_default .collapse">
<h2></h2>
<pre>$default : mixed</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_inflected_name"> </a><div class="element clickable property public property_inflected_name" data-toggle="collapse" data-target=".property_inflected_name .collapse">
<h2></h2>
<pre>$inflected_name : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"><p>. hyphens/spaces will be => _.</p></div></div></div>
</div>
<a id="property_length"> </a><div class="element clickable property public property_length" data-toggle="collapse" data-target=".property_length .collapse">
<h2></h2>
<pre>$length : int</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_name"> </a><div class="element clickable property public property_name" data-toggle="collapse" data-target=".property_name .collapse">
<h2></h2>
<pre>$name : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_nullable"> </a><div class="element clickable property public property_nullable" data-toggle="collapse" data-target=".property_nullable .collapse">
<h2></h2>
<pre>$nullable : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_pk"> </a><div class="element clickable property public property_pk" data-toggle="collapse" data-target=".property_pk .collapse">
<h2></h2>
<pre>$pk : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_raw_type"> </a><div class="element clickable property public property_raw_type" data-toggle="collapse" data-target=".property_raw_type .collapse">
<h2></h2>
<pre>$raw_type : string</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_sequence"> </a><div class="element clickable property public property_sequence" data-toggle="collapse" data-target=".property_sequence .collapse">
<h2></h2>
<pre>$sequence : boolean</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_type"> </a><div class="element clickable property public property_type" data-toggle="collapse" data-target=".property_type .collapse">
<h2></h2>
<pre>$type : integer</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"><p>..</p></div></div></div>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a id="constant_DATE"> </a><div class="element clickable constant  constant_DATE" data-toggle="collapse" data-target=".constant_DATE .collapse">
<h2>DATE</h2>
<pre>DATE </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_DATETIME"> </a><div class="element clickable constant  constant_DATETIME" data-toggle="collapse" data-target=".constant_DATETIME .collapse">
<h2>DATETIME</h2>
<pre>DATETIME </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_DECIMAL"> </a><div class="element clickable constant  constant_DECIMAL" data-toggle="collapse" data-target=".constant_DECIMAL .collapse">
<h2>DECIMAL</h2>
<pre>DECIMAL </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_INTEGER"> </a><div class="element clickable constant  constant_INTEGER" data-toggle="collapse" data-target=".constant_INTEGER .collapse">
<h2>INTEGER</h2>
<pre>INTEGER </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_STRING"> </a><div class="element clickable constant  constant_STRING" data-toggle="collapse" data-target=".constant_STRING .collapse">
<h2>STRING</h2>
<pre>STRING </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="constant_TIME"> </a><div class="element clickable constant  constant_TIME" data-toggle="collapse" data-target=".constant_TIME .collapse">
<h2>TIME</h2>
<pre>TIME </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
            generated on 2013-06-08T13:56:19-04:30.<br></footer></div>
</div>
</body>
</html>
